Formateo

Descripcion

Como debería de formatear el código para que sea facilmente legible.

Formateo

Conceptos clave:

La metáfora del periódico

El código debe de leerse como un articulo de un periodico, de arriba a abajo, empezando por los conceptos mas abstractos y avanzandos hacia los conceptos mas concretos.


Apertura vertical entre conceptos distintos

Debemos de separar los distintos bloques de código (ya sean funciones, bloques de setencias if, for...etc), con un salto de linea para que se aprecie la separación verticual que nos indica que hay dos concetos separados al leer el código a golpe de vista.

Densidad vertical entre concetos relacionados

Los conceptos que sean similares (por ejemplo variables relacionadas) debe de ir en lineas consecutivas (Sin saltos de linea), de esta manera se crea una mayor densidad vertical dando lugar a que esas lineas tienen relacion entre ellas.

Distancia vertical

Las funciones que son llamadas por otas funciones tienen que permanecer cerca verticalmente para que la lectura vertical tenga sentido

Apertura horizontal

De igual manera que usamos la separación verticual, tambien podemos usar la separación horizontal, por ejemplo al usar el operador de asignación (=) dejamos un espacio tanto a la izquierda como a la derecha, o si usamos el operador de incremento (++) lo dejamos pegado al nombre de la variable, para indicar que el operador tiene una relacion directa con una variable.

Indentación

Debemos de utilizar la indentación para indicar la gerarquía que tiene cada parte del código, normalmente tendremos un archivo, dentro de ese archivo tendremos clases, dentro de esas clases tendremos funciones, dentro de esas funciones tendremos bloques de código y a su vez dentro de esos bloques podremos tener mas bloques de manera recursiva

Cada uno de esos niveles debe de ir indentado un nivel hacia la derecha para indicar la gerarquía que tiene el código que escribimos.

Tags

Clean Code | Formateo